Paver Removal 3/3 #34832
Draft
Paver Removal 3/3 #34832
+166
−2,268
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced May 21, 2024
Closed
Merged
Open
kdmccormick
force-pushed
the
kdmccormick/paver-rm-3
branch
3 times, most recently
from
8d2f898 to
b62342d
Compare
kdmccormick
force-pushed
the
kdmccormick/paver-rm-3
branch
3 times, most recently
from
563e1cb to
1109e0b
Compare
kdmccormick
force-pushed
the
kdmccormick/paver-rm-3
branch
from
1109e0b to
0be6951
Compare
|
@feanil If you have some spare cycles to review this, would you like do the honors? |
BREAKING CHANGE: Removes all remaining Paver commands including `pavelib/prereqs.py:*` and `pavelib/assets.py:*`. BREAKING CHANGE: Removes `./manage.py [lms|cms] compile_sass`, which was just a wrapper around Paver commands. BREAKING CHANGE: Removes paver.txt. Operators should install testing.txt instead. Part of: openedx#34467
There are three packages which edx-platform needs in order to run which were being installed transitively via paver.in. Since we are removing paver.in, these dependencies need to be transferred into kernel.in: * psutil * pymemcache * wrapt Part of: openedx#34467
BREAKING CHANGE: Removes libsass from requirements/edx/base.txt. Operators will need to install requirements/edx/assets.txt in order to compile Sass. Commit generated by workflow `kdmccormick/edx-platform/.github/workflows/compile-python-requirements.yml@refs/heads/master`
This is technically a breaking change, but these commands were added a week ago and were not yet documented, so I'm not worried about breaking anyone's workflow with this commit.
kdmccormick
force-pushed
the
kdmccormick/paver-rm-3
branch
from
0be6951 to
2aa06f4
Compare
Merged
|
I'm hoping to merge a subset of this PR ASAP: The rest of this PR (all the breaking parts) will have to wait for a bit while we sort out a regression in edx-proctoring. |
feanil
approved these changes
Dec 18, 2024
There was a problem hiding this comment.
These changes look good, can we also update xmodule/tests/__init__.py and lms/envs/minimal.yml to not mention paver. The rest of the mentions I think will get cleaned up in future cleanup that we have planned around devstack settings or it is in historic documents.
Good to merge once those last two files are updated from my perspective.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This fully removes Paver from edx-platform and updates some documentation accordingly. See individual commits for more detail.
BREAKING CHANGE: Removes all remaining Paver commands including
pavelib/prereqs.py:*andpavelib/assets.py:*.BREAKING CHANGE: Removes
./manage.py [lms|cms] compile_sass, whichwas just a wrapper around Paver commands.
BREAKING CHANGE: Removes paver.txt. Operators should install testing.txt
instead.
BREAKING CHANGE: Removes libsass from requirements/edx/base.txt.
Operators will need to install requirements/edx/assets.txt in order to
compile Sass.
Note that the
build!: rejigger npm run test commandscommit is technically a breaking change, but those commands were first added a week ago and were not documented, so I don't feel like we need to raise this as BREAKING CHANGE.Supporting information
This plan has been accepted and communicated via the DEPR process:
Previous PRs (blocking this one):
Paver Removal 2/3 #34830Testing instructions
I built the Tutor openedx and openedx-dev images with this branch. I smoke tested LMS and CMS in both modes, and ensure that I could toggle between Indigo and the default theme.
I inspected the JS Test logs to ensure that we're still running 6 test suites (jest, cms-vanilla, cms-require, xmodule-vanilla, common-vanilla, common-require).
Finally, you can check out the updated edx-platform testing guide here: https://github.com/kdmccormick/edx-platform/blob/kdmccormick/paver-rm-3/docs/concepts/testing/testing.rst. Using Tutor, I installed the tutor-contrib-legacy-js plugin (from a branch:
https://github.com/kdmccormick/openedx-tutor-plugins/tree/kdmccormick/test-legacy-js/plugins/tutor-contrib-test-legacy-js) and ran JS tests locally.